Content Type Ovf OvfTemplate

Content Type Ovf OvfTemplate
Content Type Ovf OvfTemplate

Provides extra information about a library item of type "ovf".

An OVF library item is the basic building block for instantiating virtual machines from content library. It may contain one or multiple virtual machine templates. This structure provides a rich view of the virtual machines within the ovf container as well as information about to the ovf descriptor associated with the library item

JSON Example
{
    "id": "string",
    "vm_count": 0,
    "version": "string",
    "library_id_parent": "string",
    "is_vapp_template": false,
    "vm_template": {
        "vm_name": "string",
        "os_type": "string",
        "os_description": "string",
        "cpu": {
            "num_cpus": 0,
            "reservation": 0,
            "limit": 0,
            "shares": 0
        },
        "memory": {
            "size": 0,
            "reservation": 0,
            "limit": 0,
            "shares": 0
        },
        "disks": [
            {
                "name": "string",
                "disk_capacity": 0,
                "storage_policy": {
                    "group_id": "string"
                }
            }
        ],
        "nics": [
            {
                "name": "string",
                "network_name": "string",
                "mac_address": "string",
                "start_connected": false
            }
        ],
        "video_cards": [
            {
                "render_type": "string",
                "video_ram_size": 0,
                "graphics_memory_size": 0,
                "enable3d": false,
                "num_displays": 0,
                "use_auto_detect": false
            }
        ],
        "drives": [
            {
                "name": "string",
                "type": "string",
                "sub_type": "string"
            }
        ],
        "floppies": [
            {
                "name": "string",
                "connected": false,
                "type": "string"
            }
        ],
        "disk_controllers": [
            {
                "name": "string",
                "type": "string",
                "sub_type": "string"
            }
        ],
        "usb_controllers": [
            {
                "type": "string",
                "auto_connect": false,
                "ehci_pci_slot_number": 0,
                "pci_slot_number": 0
            }
        ],
        "storage_policies": [
            {
                "group_id": "string"
            }
        ]
    },
    "vapp_template": {
        "vapp_name": "string",
        "vm_templates": [
            {
                "vm_name": "string",
                "os_type": "string",
                "os_description": "string",
                "cpu": {
                    "num_cpus": 0,
                    "reservation": 0,
                    "limit": 0,
                    "shares": 0
                },
                "memory": {
                    "size": 0,
                    "reservation": 0,
                    "limit": 0,
                    "shares": 0
                },
                "disks": [
                    {
                        "name": "string",
                        "disk_capacity": 0,
                        "storage_policy": {
                            "group_id": "string"
                        }
                    }
                ],
                "nics": [
                    {
                        "name": "string",
                        "network_name": "string",
                        "mac_address": "string",
                        "start_connected": false
                    }
                ],
                "video_cards": [
                    {
                        "render_type": "string",
                        "video_ram_size": 0,
                        "graphics_memory_size": 0,
                        "enable3d": false,
                        "num_displays": 0,
                        "use_auto_detect": false
                    }
                ],
                "drives": [
                    {
                        "name": "string",
                        "type": "string",
                        "sub_type": "string"
                    }
                ],
                "floppies": [
                    {
                        "name": "string",
                        "connected": false,
                        "type": "string"
                    }
                ],
                "disk_controllers": [
                    {
                        "name": "string",
                        "type": "string",
                        "sub_type": "string"
                    }
                ],
                "usb_controllers": [
                    {
                        "type": "string",
                        "auto_connect": false,
                        "ehci_pci_slot_number": 0,
                        "pci_slot_number": 0
                    }
                ],
                "storage_policies": [
                    {
                        "group_id": "string"
                    }
                ]
            }
        ],
        "storage_policies": [
            {
                "group_id": "string"
            }
        ]
    },
    "networks": [
        {
            "name": "string",
            "description": "string"
        }
    ],
    "storage_policy_groups": [
        {
            "id": "string",
            "name": "string",
            "description": "string"
        }
    ]
}
string
id
Required

Library item id.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.library.Item.

integer As int64 As int64
vm_count
Required

Number of virtual machines in the the ovf template.

string
version
Required

A version number indicating the generation of the OvfTemplate

This value is incremented every time OvfTemplate changes.

string
library_id_parent
Required

The identifier of the Content LibraryModel to which this item belongs. This is used to set the parent of the ovf template for permission propagation.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.Library.

boolean
is_vapp_template
Required

True if this is a vApp template, otherwise this is a VM template.

vm_template
Optional

The Vitrual Machine if this is a VM template

An OVF template does not require a VM template.

vapp_template
Optional

The root VApp template in this OVF template if this is a vApp template

An OVF template does not require a vApp template.

networks
Required

networks in this OVF template

storage_policy_groups
Optional

Storage policy groups for disks, virtual machines and/or virtual machine collections.

An OVF template does not require policies.